
/**
 * @package pour documenter un package Java
 * @brief pour donner une description courte
 * @class pour documenter classe.
 * @param pour documenter un paramètre de fonction/méthode.
 * @warning pour attirer l'attention.
 * @author pour donner le nom de l'auteur.
 * @return pour documenter les valeurs de retour d'une méthode/fonction.
 * @throws pour documenter les exceptions possiblement levées.
 * @version pour donner le numéro de version.
 * @exception pour documenter une exception.
 */

/**
 *
 * Classe de gestion d'étudiants
 * @author John Doe
 * @version 2.6
 */

public class Javadoc
{
      /**
       * a public variable.
       * Details.
       */
       int publicVar;
       
      /**
       * A constructor.
       * A more elaborate description of the constructor.
       */

      public Javadoc()
      {

      }
      
      /**
       * @fn pour documenter une fonction
       * @brief pour donner une description courte
       * @param a an integer argument.
       * @param s a constant character pointer.
       * @return The test results
       */
       public void testMe(int myInt,char myChar)
       {

       }

       /**
 * Valide un mouvement de jeu d'Echecs.
 * @param leDepuisFile   File de la pièce à déplacer
 * @param leDepuisRangée Rangée de la pièce à déplacer
 * @param leVersFile     File de la case de destination
 * @param leVersRangée   Rangée de la case de destination
 * @return true/false si le mouvement d'échec est valide ou faux(false) si invalide
 */
 public boolean estUnDeplacementValide(int leDepuisFile, int leDepuisRangée, int leVersFile, int leVersRangée)
 {
    return true;
 }

      /**
       * A pure virtual member.
       * @see testMe()
       * @param c1 the first argument.
       * @param c2 the second argument.
       */
       public void testMeToo(char c1,char c2)
       {

       }


};